*
* Adds a reference to @cursor.
*
- * Return value: Same @cursor that was passed in
+ * Return value: (transfer full): Same @cursor that was passed in
*
* Deprecated: 3.0: Use g_object_ref() instead
*/
* Returns a #GdkAppLaunchContext suitable for launching
* applications on the given display.
*
- * Returns: a new #GdkAppLaunchContext for @display.
+ * Returns: (transfer full): a new #GdkAppLaunchContext for @display.
* Free with g_object_unref() when done
*
* Since: 3.0
*
* Finds or creates an atom corresponding to a given string.
*
- * Returns: the atom corresponding to @atom_name.
+ * Returns: (transfer none): the atom corresponding to @atom_name.
*/
GdkAtom
gdk_atom_intern (const gchar *atom_name,
* ever unload the module again (e.g. do not use this function in
* GTK+ theme engines).
*
- * Returns: the atom corresponding to @atom_name
+ * Returns: (transfer none): the atom corresponding to @atom_name
*
* Since: 2.10
*/
*
* Returns the selection atom for the current source window.
*
- * Return value: the selection atom, or %GDK_NONE
+ * Return value: (transfer none): the selection atom, or %GDK_NONE
*/
GdkAtom
gdk_drag_get_selection (GdkDragContext *context)
* If the event does not contain a device field, this function will
* return %NULL.
*
- * Returns: a #GdkDevice, or %NULL
+ * Returns: (transfer none): a #GdkDevice, or %NULL.
*
* Since: 3.0
**/
* If you need to keep this around over window resizes, you need to
* add a reference to it.
*
- * Returns: The offscreen surface, or %NULL if not offscreen
+ * Returns: (transfer none): The offscreen surface, or %NULL if not offscreen
*/
cairo_surface_t *
gdk_offscreen_window_get_surface (GdkWindow *window)
* The ::pick-embedded-child signal is emitted to find an embedded
* child at the given position.
*
- * Returns: the #GdkWindow of the embedded child at @x, @y, or %NULL
+ * Returns: (transfer none): the #GdkWindow of the embedded child at
+ * @x, @y, or %NULL
*
* Since: 2.18
*/
* does not have its own background and reuses the parent's, %NULL is
* returned and you'll have to query it yourself.
*
- * Returns: The pattern to use for the background or %NULL to use the
- * parent's background.
+ * Returns: (transfer none): The pattern to use for the background or
+ * %NULL to use the parent's background.
*
* Since: 2.22
**/
* there is no custom cursor set on the specified window, and it is
* using the cursor for its parent window.
*
- * Return value: a #GdkCursor, or %NULL. The returned object is owned
- * by the #GdkWindow and should not be unreferenced directly. Use
- * gdk_window_set_cursor() to unset the cursor of the window
+ * Return value: (transfer none): a #GdkCursor, or %NULL. The returned
+ * object is owned by the #GdkWindow and should not be unreferenced
+ * directly. Use gdk_window_set_cursor() to unset the cursor of the
+ * window
*
* Since: 2.18
*/
* there is no custom cursor set on the specified window, and it is
* using the cursor for its parent window.
*
- * Returns: a #GdkCursor, or %NULL. The returned object is owned
- * by the #GdkWindow and should not be unreferenced directly. Use
- * gdk_window_set_cursor() to unset the cursor of the window
+ * Returns: (transfer none): a #GdkCursor, or %NULL. The returned
+ * object is owned by the #GdkWindow and should not be unreferenced
+ * directly. Use gdk_window_set_cursor() to unset the cursor of the
+ * window
*
* Since: 3.0
**/
* Given the root window ID of one of the screen's of a #GdkDisplay,
* finds the screen.
*
- * Return value: the #GdkScreen corresponding to @xrootwin, or %NULL.
+ * Return value: (transfer none): the #GdkScreen corresponding to
+ * @xrootwin, or %NULL.
**/
GdkScreen *
_gdk_x11_display_screen_for_xrootwin (GdkDisplay *display,
*
* Looks up the #GdkVisual for a particular screen and X Visual ID.
*
- * Returns: the #GdkVisual (owned by the screen object), or %NULL
- * if the visual ID wasn't found.
+ * Returns: (transfer none): the #GdkVisual (owned by the screen
+ * object), or %NULL if the visual ID wasn't found.
*
* Since: 2.2
*/
*
* Returns the pixbuf displayed as logo in the about dialog.
*
- * Return value: the pixbuf displayed as logo. The pixbuf is
- * owned by the about dialog. If you want to keep a reference
- * to it, you have to call g_object_ref() on it.
+ * Return value: (transfer none): the pixbuf displayed as logo. The
+ * pixbuf is owned by the about dialog. If you want to keep a
+ * reference to it, you have to call g_object_ref() on it.
*
* Since: 2.6
*/
* @find_func: (scope call): a function to filter the entries
* of @accel_group with
* @data: data to pass to @find_func
- * @returns: the key of the first entry passing @find_func. The key is
- * owned by GTK+ and must not be freed.
+ * @returns: (transfer none): the key of the first entry passing
+ * @find_func. The key is owned by GTK+ and must not be freed.
*
* Finds the first entry in an accelerator group for which
* @find_func returns %TRUE and returns its #GtkAccelKey.
/**
* gtk_accel_group_from_accel_closure:
* @closure: a #GClosure
- * @returns: (allow-none): the #GtkAccelGroup to which @closure is connected, or %NULL.
+ * @returns: (transfer none): the #GtkAccelGroup to which @closure
+ * is connected, or %NULL.
*
* Finds the #GtkAccelGroup to which @closure is connected;
* see gtk_accel_group_connect().
*
* Since: 2.8
*
- * Returns: the accel closure for this action. The returned closure is
- * owned by GTK+ and must not be unreffed or modified.
+ * Returns: (transfer none): the accel closure for this action. The
+ * returned closure is owned by GTK+ and must not be unreffed
+ * or modified.
*/
GClosure *
gtk_action_get_accel_closure (GtkAction *action)
* either be a name used for gtk_binding_set_new() or the type name of
* a class used in gtk_binding_set_by_class().
*
- * Return value: %NULL or the specified binding set
+ * Return value: (transfer none): %NULL or the specified binding set
*/
GtkBindingSet*
gtk_binding_set_find (const gchar *set_name)
* Gets the #GtkCellRenderer at @x and @y coordinates inside @area and optionally
* returns the full cell allocation for it inside @cell_area.
*
- * Return value: the #GtkCellRenderer at @x and @y.
+ * Return value: (transfer none): the #GtkCellRenderer at @x and @y.
*
* Since: 3.0
*/
*
* Finds a cell property of a cell area class by name.
*
- * Return value: (allow-none): the #GParamSpec of the child property or %NULL if @aclass has no
- * child property with that name.
+ * Return value: (transfer none): the #GParamSpec of the child property
+ * or %NULL if @aclass has no child property with that name.
*
* Since: 3.0
*/
*
* Retrieves the currently focused cell for @area
*
- * Return value: the currently focused cell in @area.
+ * Return value: (transfer none): the currently focused cell in @area.
*
* Since: 3.0
*/
* then chose to activate the focus cell for which the event
* cell may have been a sibling.
*
- * Return value: the #GtkCellRenderer for which @renderer is a sibling, or %NULL.
+ * Return value: (transfer none): the #GtkCellRenderer for which @renderer
+ * is a sibling, or %NULL.
*
* Since: 3.0
*/
* Gets the #GtkCellRenderer in @area that is currently
* being edited.
*
- * Return value: The currently edited #GtkCellRenderer
+ * Return value: (transfer none): The currently edited #GtkCellRenderer
*
* Since: 3.0
*/
* Gets the #GtkCellEditable widget currently used
* to edit the currently edited cell.
*
- * Return value: The currently active #GtkCellEditable widget
+ * Return value: (transfer none): The currently active #GtkCellEditable widget
*
* Since: 3.0
*/
* that the #GtkCellArea is configured with in order to
* compute a proper allocation.
*
- * Return value: the #GtkCellArea this context was created by.
+ * Return value: (transfer none): the #GtkCellArea this context was created by.
*
* Since: 3.0
*/
/**
* gtk_container_class_find_child_property:
- * @cclass: a #GtkContainerClass
+ * @cclass: (type GtkContainerClass): a #GtkContainerClass
* @property_name: the name of the child property to find
- * @returns: (allow-none): the #GParamSpec of the child property or %NULL if @class has no
- * child property with that name.
+ * @returns: (transfer none): the #GParamSpec of the child property or
+ * %NULL if @class has no child property with that name.
*
* Finds a child property of a container class by name.
*/
* currently focused widget. That can be obtained by calling
* gtk_window_get_focus().
*
- * Returns: The child widget which will recieve the focus inside @container when
- * the @conatiner is focussed, or %NULL if none is set.
+ * Returns: (transfer none): The child widget which will receive the
+ * focus inside @container when the @conatiner is focussed,
+ * or %NULL if none is set.
*
* Since: 2.14
**/
* Returns the list of targets this widget can accept from
* drag-and-drop.
*
- * Return value: the #GtkTargetList, or %NULL if none
+ * Return value: (transfer none): the #GtkTargetList, or %NULL if none
**/
GtkTargetList*
gtk_drag_dest_get_target_list (GtkWidget *widget)
* that case, they will have to implement a drag_motion handler that
* passes the correct target list to this function.
*
- * Return value: first target that the source offers and the dest can
- * accept, or %GDK_NONE
+ * Return value: (transfer none): first target that the source offers
+ * and the dest can accept, or %GDK_NONE
**/
GdkAtom
gtk_drag_dest_find_target (GtkWidget *widget,
* (remember to free the event with gdk_event_free() when you are done).
* If you can really not pass a real event, pass #NULL instead.
*
- * Return value: the context for this drag.
+ * Return value: (transfer none): the context for this drag.
**/
GdkDragContext *
gtk_drag_begin (GtkWidget *widget,
* Gets the list of targets this widget can provide for
* drag-and-drop.
*
- * Return value: the #GtkTargetList, or %NULL if none
+ * Return value: (transfer none): the #GtkTargetList, or %NULL if none
*
* Since: 2.4
**/
* widget that will display the icon, instead of using this
* function directly, so that themes are taken into account.
*
- * Return value: icon set of @stock_id.
+ * Return value: (transfer none): icon set of @stock_id.
*/
GtkIconSet *
gtk_icon_factory_lookup (GtkIconFactory *factory,
* using this function directly, so that themes are taken into
* account.
*
- * Return value: a #GtkIconSet, or %NULL
+ * Return value: (transfer none): a #GtkIconSet, or %NULL
*/
GtkIconSet *
gtk_icon_factory_lookup_default (const gchar *stock_id)
* effective attributes for the label, use
* pango_layout_get_attribute (gtk_label_get_layout (label)).
*
- * Return value: the attribute list, or %NULL if none was set.
+ * Return value: (transfer none): the attribute list, or %NULL
+ * if none was set.
**/
PangoAttrList *
gtk_label_get_attributes (GtkLabel *label)
* the current event will be the #GdkEventButton that triggered
* the ::clicked signal.
*
- * Return value: a copy of the current event, or %NULL if there is
- * no current event. The returned event must be freed with
- * gdk_event_free().
+ * Return value: (transfer full): a copy of the current event, or
+ * %NULL if there is no current event. The returned event must be
+ * freed with gdk_event_free().
*/
GdkEvent*
gtk_get_current_event (void)
*
* Returns the #GtkWidget that the menu is attached to.
*
- * Returns: the #GtkWidget that the menu is attached to
+ * Returns: (transfer none): the #GtkWidget that the menu is attached to
*/
GtkWidget*
gtk_menu_get_attach_widget (GtkMenu *menu)
* Returns the selected menu item from the menu. This is used by the
* #GtkOptionMenu.
*
- * Returns: the #GtkMenuItem that was last selected in the menu. If a
- * selection has not yet been made, the first menu item is
- * selected.
+ * Returns: (transfer none): the #GtkMenuItem that was last selected
+ * in the menu. If a selection has not yet been made, the
+ * first menu item is selected.
*/
GtkWidget*
gtk_menu_get_active (GtkMenu *menu)
* Gets the #GtkAccelGroup which holds global accelerators for the
* menu. See gtk_menu_set_accel_group().
*
- * Returns: the #GtkAccelGroup associated with the menu.
+ * Returns: (transfer none): the #GtkAccelGroup associated with the menu.
*/
GtkAccelGroup*
gtk_menu_get_accel_group (GtkMenu *menu)
*
* Gets the currently selected item.
*
- * Returns: the currently selected item
+ * Returns: (transfer none): the currently selected item
*
* Since: 3.0
*/
* The parent menu shell of a submenu is the #GtkMenu or #GtkMenuBar
* from which it was opened up.
*
- * Returns: the parent #GtkMenuShell
+ * Returns: (transfer none): the parent #GtkMenuShell
*
* Since: 3.0
*/
* necessary properties to the notebook (e.g. the
* #GtkNotebook:group ).
*
- * Returns: a #GtkNotebook that @page should be added to, or %NULL.
+ * Returns: (transfer none): a #GtkNotebook that @page should be
+ * added to, or %NULL.
*
* Since: 2.12
*/
*
* Creates a new unthemed #GtkNumerableIcon.
*
- * Returns: a new #GIcon
+ * Returns: (transfer full): a new #GIcon
*
* Since: 3.0
*/
* to the passed #GtkStyleContext. This is a convenience constructor
* that calls gtk_numerable_icon_set_style_context() internally.
*
- * Returns: a new #GIcon
+ * Returns: (transfer full): a new #GIcon
*
* Since: 3.0
*/
*
* Gets the currently selected page setup from the dialog.
*
- * Returns: the current page setup
+ * Returns: (transfer none): the current page setup
*
* Since: 2.10
**/
*
* Gets the current print settings from the dialog.
*
- * Returns: the current print settings
+ * Returns: (transfer none): the current print settings
*
* Since: 2.10
**/
* Obtains the cairo context that is associated with the
* #GtkPrintContext.
*
- * Return value: the cairo context of @context
+ * Return value: (transfer none): the cairo context of @context
*
* Since: 2.10
*/
*
* Returns the backend of the printer.
*
- * Return value: the backend of @printer
+ * Return value: (transfer none): the backend of @printer
*
* Since: 2.10
*/
*
* Gets the #GtkPrintSettings of the print job.
*
- * Return value: the settings of @job
+ * Return value: (transfer none): the settings of @job
*
* Since: 2.10
*/
*
* Gets the #GtkPrinter of the print job.
*
- * Return value: the printer of @job
+ * Return value: (transfer none): the printer of @job
*
* Since: 2.10
*/
* Gets a cairo surface onto which the pages of
* the print job should be rendered.
*
- * Return value: the cairo surface of @job
+ * Return value: (transfer none): the cairo surface of @job
*
* Since: 2.10
**/
* setup dialog. See gtk_print_run_page_setup_dialog_async() if this is
* a problem.
*
- * Return value: a new #GtkPageSetup
+ * Return value: (transfer full): a new #GtkPageSetup
*
* Since: 2.10
*/
* signal is emitted on the operation. Then you can read out any
* information you need from the widgets.
*
- * Returns: A custom widget that gets embedded in the print dialog,
- * or %NULL
+ * Returns: (transfer none): A custom widget that gets embedded in
+ * the print dialog, or %NULL
*
* Since: 2.10
*/
*
* Gets the currently selected printer.
*
- * Returns: the currently selected printer
+ * Returns: (transfer none): the currently selected printer
*
* Since: 2.10
*/
*
* Gets the page setup that is used by the #GtkPrintUnixDialog.
*
- * Returns: the page setup of @dialog.
+ * Returns: (transfer none): the page setup of @dialog.
*
* Since: 2.10
*/
*
* Creates a new #GtkRadioButton with a text label.
*
- * Returns: (transfer full): a new radio button.
+ * Returns: a new radio button.
*/
GtkWidget*
gtk_radio_button_new_with_label (GSList *group,
* gtk_label_new_with_mnemonic(), so underscores in @label indicate the
* mnemonic for the button.
*
- * Returns: (transfer full): a new #GtkRadioButton
+ * Returns: a new #GtkRadioButton
*/
GtkWidget*
gtk_radio_button_new_with_mnemonic (GSList *group,
* created styles, so a new style may not be
* created.)
*
- * Returns: the resulting style. No refcount is added
- * to the returned style, so if you want to save this
- * style around, you should add a reference yourself.
+ * Returns: (transfer none): the resulting style. No refcount is added
+ * to the returned style, so if you want to save this style around,
+ * you should add a reference yourself.
*
* Deprecated:3.0: Use #GtkStyleContext instead
**/
*
* Retrieves the icon associated to the resource MIME type.
*
- * Return value: a #GIcon containing the icon, or %NULL. Use
+ * Return value: (transfer full): a #GIcon containing the icon, or %NULL. Use
* g_object_unref() when finished using the icon
*
* Since: 2.22
*
* Creates a new #GtkTargetList from an array of #GtkTargetEntry.
*
- * Return value: the new #GtkTargetList.
+ * Return value: (transfer full): the new #GtkTargetList.
**/
GtkTargetList *
gtk_target_list_new (const GtkTargetEntry *targets,
*
* Retrieves the selection #GdkAtom of the selection data.
*
- * Returns: the selection #GdkAtom of the selection data.
+ * Returns: (transfer none): the selection #GdkAtom of the selection data.
*
* Since: 2.16
**/
*
* Retrieves the target of the selection.
*
- * Returns: the target of the selection.
+ * Returns: (transfer none): the target of the selection.
*
* Since: 2.14
**/
*
* Retrieves the data type of the selection.
*
- * Returns: the data type of the selection.
+ * Returns: (transfer none): the data type of the selection.
*
* Since: 2.14
**/
* and the default icon factory, returning an icon set if found,
* otherwise %NULL.
*
- * Return value: icon set of @stock_id
+ * Return value: (transfer none): icon set of @stock_id
*
* Deprecated:3.0: Use gtk_style_context_lookup_icon_set() instead
*/
*
* Returns the #GdkScreen to which @context is attached.
*
- * Returns: a #GdkScreen.
+ * Returns: (transfer none): a #GdkScreen.
**/
GdkScreen *
gtk_style_context_get_screen (GtkStyleContext *context)
* object is const and will remain valid until the
* #GtkStyleContext::changed signal happens.
*
- * Returns: the #PangoFontDescription for the given state. This
- * object is owned by GTK+ and should not be freed.
+ * Returns: (transfer none): the #PangoFontDescription for the given
+ * state. This object is owned by GTK+ and should not be
+ * freed.
*
* Since: 3.0
**/
* Returns the symbolic color that is mapped
* to @name.
*
- * Returns: The mapped color
+ * Returns: (transfer none): The mapped color
*
* Since: 3.0
**/
* Returns the style settings affecting a widget defined by @path, or %NULL if
* @provider doesn't contemplate styling @path.
*
- * Returns: a #GtkStyleProperties containing the style settings affecting @path
+ * Returns: (transfer full): a #GtkStyleProperties containing the
+ * style settings affecting @path
*
* Since: 3.0
**/
* Returns the #GtkIconFactory defined to be in use for @path, or %NULL if none
* is defined.
*
- * Returns: The icon factory to use for @path, or %NULL
+ * Returns: (transfer none): The icon factory to use for @path, or %NULL
*
* Since: 3.0
**/
* so this function is genrally only useful in test programs with
* predetermined locales, see gtk_test_init() for more details.
*
- * Returns: a GtkLabel widget if any is found.
+ * Returns: (transfer none): a GtkLabel widget if any is found.
*
* Since: 2.14
**/
* widget, relative to another labeling widget. Such as finding a
* button or text entry widget, given it's corresponding label widget.
*
- * Returns: a widget of type @widget_type if any is found.
+ * Returns: (transfer none): a widget of type @widget_type if any is found.
*
* Since: 2.14
**/
* gtk_test_widget_click() for possible caveats involving the search of
* such widgets and synthesizing widget events.
*
- * Returns: a valid widget if any is found or %NULL.
+ * Returns: (transfer none): a valid widget if any is found or %NULL.
*
* Since: 2.14
**/
* The window will quit any running gtk_main()-loop when destroyed, and it
* will automatically be destroyed upon test function teardown.
*
- * Returns: a widget pointer to the newly created GtkWindow.
+ * Returns: (transfer none): a widget pointer to the newly created GtkWindow.
*
* Since: 2.14
**/
* using gtk_target_list_add_rich_text_targets() and
* gtk_target_list_add_text_targets().
*
- * Return value: the #GtkTargetList
+ * Return value: (transfer none): the #GtkTargetList
*
* Since: 2.10
**/
* using gtk_target_list_add_rich_text_targets() and
* gtk_target_list_add_text_targets().
*
- * Return value: the #GtkTargetList
+ * Return value: (transfer none): the #GtkTargetList
*
* Since: 2.10
**/
* This function registers a rich text serialization @function along with
* its @mime_type with the passed @buffer.
*
- * Return value: the #GdkAtom that corresponds to the newly registered
- * format's mime-type.
+ * Return value: (transfer none): the #GdkAtom that corresponds to the
+ * newly registered format's mime-type.
*
* Since: 2.10
**/
* identifier != %NULL here, since the %NULL tagset requires the
* receiving buffer to deal with with pasting of arbitrary tags.
*
- * Return value: the #GdkAtom that corresponds to the newly registered
- * format's mime-type.
+ * Return value: (transfer none): the #GdkAtom that corresponds to the
+ * newly registered format's mime-type.
*
* Since: 2.10
**/
* This function registers a rich text deserialization @function along with
* its @mime_type with the passed @buffer.
*
- * Return value: the #GdkAtom that corresponds to the newly registered
- * format's mime-type.
+ * Return value: (transfer none): the #GdkAtom that corresponds to the
+ * newly registered format's mime-type.
*
* Since: 2.10
**/
* format with the passed @buffer. See
* gtk_text_buffer_register_serialize_tagset() for details.
*
- * Return value: the #GdkAtom that corresponds to the newly registered
- * format's mime-type.
+ * Return value: (transfer none): the #GdkAtom that corresponds to the
+ * newly registered format's mime-type.
*
* Since: 2.10
**/
*
* Returns the font description for a given state.
*
- * Returns: the #PangoFontDescription for the given state. This
- * object is owned by GTK+ and should not be freed.
+ * Returns: (transfer none): the #PangoFontDescription for the given
+ * state. This object is owned by GTK+ and should not be
+ * freed.
*
* Since: 3.0
**/
*
* Returns the #GdkScreen to which @engine currently rendering to.
*
- * Returns: a #GdkScreen, or %NULL.
+ * Returns: (transfer none): a #GdkScreen, or %NULL.
**/
GdkScreen *
gtk_theming_engine_get_screen (GtkThemingEngine *engine)
* gtk_widget_class_find_style_property:
* @klass: a #GtkWidgetClass
* @property_name: the name of the style property to find
- * @returns: (allow-none): the #GParamSpec of the style property or %NULL if @class has no
- * style property with that name.
+ * @returns: (transfer none): the #GParamSpec of the style property or
+ * %NULL if @class has no style property with that name.
*
* Finds a style property of a widget class by name.
*
*
* Gets the #GtkApplication associated with the window (if any).
*
- * Return value: a #GtkApplication, or %NULL
+ * Return value: (transfer none): a #GtkApplication, or %NULL
*
* Since: 3.0
**/
* Gets the current grab widget of the given group,
* see gtk_grab_add().
*
- * Returns: the current grab widget of the group
+ * Returns: (transfer none): the current grab widget of the group
*
* Since: 2.22
*/
*
* Returns the current grab widget for @device, or %NULL if none.
*
- * Returns: The grab widget, or %NULL
+ * Returns: (transfer none): The grab widget, or %NULL
*
* Since: 3.0
*/
projects / gtk4.git / commitdiff